Xceed .NET Libraries Documentation
Xceed.Compression.Formats Assembly / Xceed.Compression.Formats Namespace / GZipCompressedStream Class / Compress Method / Compress(Byte[],Int32,Int32,CompressionLevel) Method
The array of bytes to compress. A maximum of count bytes are taken from this array and compressed.
The byte offset in buffer at which to begin taking the data to compress.
The maximum number of bytes to be taken from buffer.
A Xceed.Compression.CompressionLevel value representing the compression level to use.


In This Topic
    Compress(Byte[],Int32,Int32,CompressionLevel) Method
    In This Topic
    Compresses an array of bytes using the GZip compression format specifying the amount of bytes to compress as well as the compression level.
    Syntax
    'Declaration
     
    Public Overloads Shared Function Compress( _
       ByVal buffer() As Byte, _
       ByVal offset As Integer, _
       ByVal count As Integer, _
       ByVal level As CompressionLevel _
    ) As Byte()
    'Usage
     
    Dim buffer() As Byte
    Dim offset As Integer
    Dim count As Integer
    Dim level As CompressionLevel
    Dim value() As Byte
     
    value = GZipCompressedStream.Compress(buffer, offset, count, level)
    public static byte[] Compress( 
       byte[] buffer,
       int offset,
       int count,
       CompressionLevel level
    )

    Parameters

    buffer
    The array of bytes to compress. A maximum of count bytes are taken from this array and compressed.
    offset
    The byte offset in buffer at which to begin taking the data to compress.
    count
    The maximum number of bytes to be taken from buffer.
    level
    A Xceed.Compression.CompressionLevel value representing the compression level to use.

    Return Value

    An array of bytes containing the compressed data. Can be empty.
    Remarks

    The Xceed.Compression.CompressionMethod.Deflated compression method will always be used.

    If the data to compress is not a byte array, it will need to be converted into a byte array before it can be compressed. This can be done, in the case of a string, using the System.Text.Encoding.GetBytes(System.Char[]) method of the System.Text.Encoding class.

    The compression level only applies to the Deflated and Deflated64 compression methods.  It does not apply to the BZip2, BWT, or PPMd compression methods.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also